/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */

package org.openmrs.module.clinicalsummary.predicate;

import java.util.Set;

public interface Predicate {

	/**
	 * Check whether a property is supported by the predicate or not
	 *
	 * @param propertyName the property name to be checked
	 * @return true if the predicate support evaluation on the property
	 */
	Boolean supportedProperty(String propertyName);

	/**
	 * Get all supported properties for the particular predicate
	 *
	 * @return all supported properties for the predicate
	 */
	Set<String> getSupportedProperties();

	/**
	 * Evaluate the predicate on the object and return true if the object conform to the predicate
	 *
	 * @param object object where the predicate should be evaluated
	 * @return true if the expected value of the property match the value in this predicate
	 */
	Boolean evaluate(Object object);

	/**
	 * Get the property on which this predicate should be evaluated
	 *
	 * @return the property
	 */
	String getProperty();

	/**
	 * Get the expected type of the property
	 *
	 * @return the type of the property
	 */
	Class getType();

	/**
	 * Get the expected value of the property
	 *
	 * @return the expected value
	 */
	Object getValue();
}
